ATSUGetTextLocation

Obtains information about text, including its in physical memory.

OSStatus ATSUGetTextLocation (
                     ATSUTextLayout iTextLayout,
                     void **oText,
                     Boolean *oTextIsStoredInHandle,
                     UniCharArrayOffset *oOffset,
                     UniCharCount *oTextLength,
                     UniCharCount *oTextTotalLength);
iTextLayout
A reference of type ATSUTextLayout. Pass a reference to an initialized text layout object.

oText
A pointer of type ConstUniCharArrayPtr or a handle of type UniCharArrayHandle, depending on the value passed back in oTextIsStoredInHandle. If true, on return, oText contains a handle pointing to the beginning of the text buffer. If false, on return, oText contains a pointer to the beginning of the text buffer.

oTextIsStoredInHandle
A pointer to a Boolean value. On return, the value indicates whether the text buffer in oText is accessed by a handle or pointer. If true, the text buffer is accessed by handle; if false, the text buffer is accessed by pointer.

oOffset
A pointer to a value of type UniCharArrayOffset. On return, the edge offset in backing store memory that corresponds to the beginning of range of text that ATSUI performs layout operations on.

oTextLength
A pointer to a value of type UniCharCount. On return, the length of the range of text that ATSUI performs layout operations on.

oTextTotalLength
A pointer to a value of type UniCharCount. On return, the length of the entire text buffer.

function result
A result code. See Result Codes.
DISCUSSION
The ATSUGetTextLocation function obtains the location of text in physical memory, the length of the range of text and text buffer, and whether the text is accessed by a pointer or handle.

VERSION NOTES
Available beginning with ATSUI 1.0.


© 2000 Apple Computer, Inc. – (Last Updated 25 Jan 00)